Extend style guide "Use simple language" section #1624
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
AA-Turner
reviewed
Aug 6, 2025
Comment on lines
+111
to
+113
| - Abbreviations, such as Latin "e.g." or "i.e.," or symbols, such as the | ||
| ampersand ('&'), where English words will do, such as | ||
| "for example", "that is" and "and," respectively. |
There was a problem hiding this comment.
I don't agree with discouraging '&'. It's relatively common, and helps distinguish items in a list, e.g. "Tom & Jerry and Barbie & Ken have both featured in major animated works".
AA-Turner
reviewed
Aug 6, 2025
Comment on lines
+114
to
+115
| - Idioms, as they are often confusing to non-native speakers and | ||
| are difficult to translate. |
There was a problem hiding this comment.
I've said elsewhere, but part of the draw of Python is that it has historically been less 'clinical'/corporate/dry than other languages, and silly examples (Monty Python) & idioms in prose are part of that. I think there's a fine balance between avoiding overuse and confusion and a prohibition: I would be sad to see this type of thing go.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The diff is quite short, and I think it will explain better than a comment here. A section on gender neutrality may also be a good addition, there is in fact already one in the translation style guide.